[:en]Need data and instructions for integration or data export?
Take advantage of our instructions.
Obtaining an API Key
Adding a task (number) to a dialer
Removing a task (number) from a dialer
Call Log
Adding call data
Retrieving call data
Retrieving a call recording
Summary reports by queues and users
Changing the agent\’s status
Exporting contacts from CRM
Checking for the existence of a value in the list
Complete order details (SHOP module)
API for the list of dialers
API v.1
Obtaining an API Key
The API Key is created in your user settings.
![width=\"600\"](\"/wp-content/uploads/2021/10/1-6-e1595591671319-600x379.png\")
Adding a task (number) to a dialer
URL https://home.oki-toki.net/docs/api/#dialers-GETapi-v1-dialers-create_task
Method: POST or GET
*The API Key is created in your user settings, as shown in the first point of the documentation
Variable transmission:
By standard method in POST or GET request
In a non-standard way. POST or GET variable json_request must contain a json string with data for adding a task
Authorization by user api token. The request must necessarily contain a variable api_token containing the user token.
Mandatory data:
dialer_id – the dialer number to which to add a task
phones – phone numbers, maximum 5. Separated by a comma or as a json substring (if passed in json_request)
Optional data:
contact_id – the contact number from Oki-Toki CRM,
bp_id – the process number from Oki-Toki CRM,
date – the time the calls are scheduled for, in the format 21.02.2017 12:00:00,
import_id – the import number,
priority from 0 to 2,
region in the time zone format. for example Europe/Kiev (if the region is specified but is empty, then autocorrection of the zone (if enabled) will not work, the customer schedule will not work, and the call will go according to the dialer\’s operating schedule),
ttl the lifetime of the task, in seconds,
user_id the user number to assign the task to,
details – a json substring with additional information, for example {\”name\”:\”John\”, \”order\”:\”12\”}
force_create – 1 or 0. If force_create=1, uniqueness is enabled in the dialer settings and the task is not added due to this very uniqueness, then when adding all existing tasks conflicting with the added by a unique key will automatically be canceled,
task_id – the task number in the dialer. if specified, phone numbers will be added to the task with the specified number, if it is in progress,
reset_task_id – the task number in the dialer. if specified – the system will try to find this task and put it into work, instead of creating a new one. If phone numbers (phones) are specified, then the system will put only those specified into work. if the task does not have any specified number – it will be added to it. if numbers are not specified – all phones in the task will be queued.
The response returns a message about successful task addition with its number, or an error message.
Removing a task (number) from a dialer
URL https://noname.oki-toki.net/api/v1/dialers/cancel_task
Method: POST or GET
*The API Key is created in your user settings, as shown in the first point of the documentation.
Variable transmission:
By standard method in POST or GET request.
In a non-standard way. POST or GET variable json_request must contain a json string with data for adding a task.
Authorization by user api token. The request must necessarily contain a variable api_token containing the user token.
Mandatory data:
dialer_id – the dialer number from which to remove a task (if the number = 0, then it is removed from all dialers).
Optional data:
task_id – the task number,
phone – the phone number that is in the task,
contact_id – the contact number from Oki-Toki CRM,
bp_id – the process number from Oki-Toki CRM,
details – a json substring with additional information, for example {\”name\”:\”John\”, \”order\”:\”12\”}. Tasks with the specified additional information are canceled,
cancel_phone – 1 (flag, if set, then cancels only the specified phone number),
cancel_reason – the reason for cancellation (can be one of: wrong_number).
It is possible to combine optional parameters with each other, then different tasks will be deleted. For example: you can delete all tasks with a specific phone number, or with details.
If none of the optional parameters is specified, an error will be returned.
The response returns a message about the successful cancellation of the task(s) with its(their) number(s), or an error message.
Call Log
URL https://noname.oki-toki.net/api/v1/reports/acd/calls-log
Method: GET
*The API Key is created in your user settings, as shown in the first point of the documentation.
Authorization by user api token. The request must necessarily contain a variable api_token, containing the user token.
Without parameters, it returns calls for the last hour.
Parameters:
date_range – the period for which to return data. Values: last_hour, today, yesterday, this_week, prev_week, this_month, prev_month,
date – the date for which to return calls,
anis – phone number or session ID,
format – the format in which to return the result. Values: default, csv, csv_2016. By default, it returns in JSON, csv – CP-1251 encoding, csv_2016 – UTF-8 encoding.
As well as all other fields used in the filter of this report. Variable names and values can be taken from the report form. You can also perform a report in the web interface with the required parameters, and copy the part of the url with parameters from the address bar, adding your api_token to it.
Examples
Replace the asterisks with your api_token
Today\’s calls:
https://noname.oki-toki.net/api/v1/reports/acd/calls-log?date_range=today&api_token=****
Searching for a call with session ID 12345678, made on 29.08.2017:
https://noname.oki-toki.net/api/v1/reports/acd/calls-log?date=28.08.2017&anis=12345678&api_token=****
Calls to/from the number 380501234567, made last week:
https://noname.oki-toki.net/api/v1/reports/acd/calls-log?date_range=prev_week&anis=380501234567&api_token=****
All calls last week in CSV (\”Cyrillic Windows-1251\” encoding):
https://noname.oki-toki.net/api/v1/reports/acd/calls-log?date_range=this_week&format=csv&api_token=****
Adding call data
URL https://noname.oki-toki.net/api/v1/call/add_data
Method: POST or GET
*The API Key is created in your user settings, as shown in the first point of the documentation.
Data transmission:
By standard method in POST or GET request
In a non-standard way. POST or GET variable json_request must contain a json string with data.
Authorization by user api token. The request must necessarily contain a variable api_token containing the user token.
Mandatory data:
session_id – the unique call number in the Oki-Toki system to which data are added
Note.
If data is added repeatedly, it will be added to the previously added data.
If the value of some parameter is empty, then this parameter will be removed from the dataset.
The response returns a message about successful data addition with the call number, or an error message.
Retrieving call data
URL https://noname.oki-toki.net/api/v1/call/get_data
Method: POST or GET
*The API Key is created in your user settings, as shown in the first point of the documentation.
Data transmission:
By standard method in POST or GET request
In a non-standard way. POST or GET variable json_request must contain a json string with data.
Authorization by user api token. The request must necessarily contain a variable api_token containing the user token.
Mandatory data:
session_id – the unique call number in the Oki-Toki system to which data are added,
date – the call date in the format DD.MM.YYYY.
The response returns a message with call data, or an error message.
Retrieving a call recording
URL https://noname.oki-toki.net/api/v1/record/{session_id}
Method: GET
*The API Key is created in your user settings, as shown in the first point of the documentation.
Authorization by user api token. The request must necessarily contain a variable api_token, containing the user token.
Parameters:
date – the call date. If not specified, searches for the last three months
Example:
https://noname.oki-toki.net/api/v1/record/1234567?date=26.09.2017&api_token=****
Summary report on calls
URL https://noname.oki-toki.net/api/v1/reports/acd/calls-summary
Method: GET
*The API Key is created in your user settings, as shown in the first point of the documentation.
Authorization by the user\’s api token. The request must necessarily contain a variable api_token, containing the user token.
Without parameters, it returns calls for the last hour.
Parameters:
date_range – the period for which to return data. Values: last_hour, today, yesterday, this_week, prev_week, this_month, prev_month.
As well as all other fields used in the filter of this report. Variable names and values can be taken from the form of the report. You can also perform a report in the web interface with the required parameters, and copy the part of the url with parameters from the address bar, adding your api_token to it.
Summary reports by queues and users
URL https://noname.oki-toki.net/api/v1/reports/sec/queue-status-summary (queues)
and https://noname.oki-toki.net/api/v1/reports/sec/user-status-summary (users)
Method: GET
*The API Key is created in your user settings, as shown in the first point of the documentation.
Authorization by user api token. The request must necessarily contain a variable api_token, containing the user token.
Without parameters, it returns statuses for the last hour without breakdown.
Parameters:
date_range – the period for which to return data. Values: last_hour, today, yesterday, this_week, prev_week, this_month, prev_month.
split_by – split by queues or users. Values: queue, user.
As well as all other fields used in the filter of this report. Variable names and values can be taken from the report form. You can also perform a report in the web interface with the required parameters, and copy the part of the url with parameters from the address bar, adding your api_token to it.
Changing the agent\’s status
URL https://noname.oki-toki.net/api/v1/user/set_status
Method: POST or GET
*The API Key is created in your user settings, as shown in the first point of the documentation.
Variable transmission:
By standard method in POST or GET request
In a non-standard way. POST or GET variable json_request must contain a json string with data for changing the status
Authorization by user api token. The request must necessarily contain a variable api_token containing the user token.
Mandatory data:
user_id – the user number
status_id – status number (see here https://noname.oki-toki.net/company/statuses)
Optional data:
away_status_id – an additional status number (see here https://noname.oki-toki.net/company/statuses),
status_comment – comment to the status.
The response returns a message about successful status change, or an error message.
Exporting contacts from CRM
URL https://noname.oki-toki.net/api/v1/contacts
Method: GET
*The API Key is created in your user settings, as shown in the first point of the documentation.
Variable transmission:
By standard method in GET request
Authorization by user api token. The request must necessarily contain a variable api_token containing the user token.
Contact selection filter:
contact_field1=value1&contact_field2=value2&contact_field3=*value3&
contact_field4=*value4*
contact_field – The name of the contact field, as it appears in the contact.
=value – exact match with the specified value,
=*value* – contains the specified value
=*value – the specified value is at the end of the field,
=value* – the specified value is at the beginning of the field,
value may be a list in the format of a list [1,2,3,4]. Then, a contact will be found whose value of the specified field is in the list.
The response returns a json array containing the found contacts. The number of contacts is limited to 1000.
Checking for the existence of a value in the list
URL https://noname.oki-toki.net/api/v1/lists/check
Method: GET
*The API Key is created in your user settings, as shown in the first point of the documentation.
Variable transmission:
By standard method in GET request
Authorization by user api token. The request must necessarily contain a variable api_token containing the user token.
Mandatory data:
list_id – the list number for checking
Checking parameters:
value – the value
The response returns 1 if in the list. 0 – if not.
Complete order details (SHOP module)
URL https://noname.oki-toki.net/api/v1/shop/order/$id
Method: GET
*The API Key is created in your user settings, as shown in the first point of the documentation.
Variable transmission:
By standard method in GET request
Authorization by user api token. The request must necessarily contain a variable api_token containing the user token.
Mandatory data:
$id – the order number
The response returns full order details including its contents.
API for the list of dialers
URL https://noname.oki-toki.net/api/v1/dialers/stat
Method: GET
*The API Key is created in your user settings, as shown in the first point of the documentation.
Variable transmission:
By standard method in GET request
Authorization by user api token. The request must necessarily contain a variable api_token containing the user token.
Optional data:
$dialer_id – the dialer number
The response returns data on all non-archive dialers, or if $dialer_id is specified – only about one.[:ru]Нужны данные и инструкции для интеграции или выгрузки данных?
Воспользуйтесь нашими инструкциями.
Получение ключа API
Добавление задачи (номера) в обзвон
Удаление задачи (номера) из обзвона
Журнал звонков
Добавление данных о звонке
Получение данных о звонке
Получение записи разговора
Сводные отчеты по очередям и пользователям
Смена статуса оператора
Выгрузка контактов из CRM
Проверка существования значения в списке
Полные данные о заказе (модуль SHOP)
API для списка автообзвонов
API v.1
Получение ключа API
Ключ API создается в настройках вашего пользователя.
Добавление задачи (номера) в обзвон
URL
Method: POST or GET
*ключ API создается в настройках Вашего пользователя, как показано в первом пункте документации
Передача переменных:
Стандартным способом в POST или GET запросе
Нестандартным способом. POST или GET переменная json_request должна содержать в себе json строку с данными для добавления задачи
Авторизация по апи токену пользователя. В запросе обязательно должна быть переменная api_token содержащая токен пользователя.
Обязательные данные:
dialer_id – номер автообзвона в который добавлять задачу
phones – номера телефонов, максимум 5. Через запятую, либо json подстрокой (если переаlется в json_request)
Необязательные данные:
contact_id – номер контакта из CRM Oki-Toki,
bp_id – номер процесса из CRM Oki-Toki,
date – время на которое назначаются звонки, в формате 21.02.2017 12:00:00,
import_id – номер импорта,
priority приоритет от 0 до 2,
region регион в формате часовой зоны. например Europe/Kiev (если регион будет указан, но будет пустым, то автокоррекция пояса(если включена) не сработает, клиентское расписание не сработает, и звонок пойдет по расписанию работы автообзвона),
ttl время жизни задачи, в секундах,
user_id номер пользователя на которого назначить задачу,
details – json подстрока с дополнительной информацией, например {\”name\”:\”John\”, \”order\”:\”12\”}
force_create – 1 или 0. Если force_create=1, в настройках автообзвона включена уникальность и задача не добавляется по причине этой самой уникальности, то при добавлении все существующие задачи конфликтующие с добавляемой по уникальному ключу автоматически отменятся,
task_id – номер задачи в автообзвоне. если указан то номера телефонов добавятся к задаче с указаным номером, если она в работе,
reset_task_id – номер задачи в автообзвоне. если указан – то система попытется найти эту задачу и поставить ее в работу, вместо того что бы создавать новую. Если заданы номера телефонов (phones), то система поставит в работу только те которые заданы. если у задачи нет какого либо указаного номера – то он бует к ней добавлен. если номера не указаны – все телефоны в задаче станут в очередь.
В ответ возвращается сообщение об успешном добавлении задачи с ее номером, либо сообщение об ошибке.
Удаление задачи (номера) из обзвона
URL https://noname.oki-toki.net/api/v1/dialers/cancel_task
Method: POST or GET
*ключ API создается в настройках Вашего пользователя, как показано в первом пункте документации.
Передача переменных:
Стандартным способом в POST или GET запросе.
Нестандартным способом. POST или GET переменная json_request должна содержать в себе json строку с данными для добавления задачи.
Авторизация по апи токену пользователя. В запросе обязательно должна быть переменная api_token содержащая токен пользователя.
Обязательные данные:
dialer_id – номер автообзвона из которого удалять задачу (если номер = 0, то удаляется со всех автообзвонов).
Необязательные данные:
task_id – номер задачи,
phone – номер телефона,который есть в задаче,
contact_id – номер контакта из Оки-Токи CRM,
bp_id – номер процесса из Оки-Токи CRM,
details – json подстрока с дополнительной информацией, например {\”name\”:\”John\”, \”order\”:\”12\”}. Отменяются задачи в которых есть заданная дополнительная информация,
cancel_phone – 1 (флаг, если установлен, то отменяет только указанный номер телефона),
cancel_reason – причина отмены (может быть следующим из: wrong_number).
Возможно комбинировать необязательные параметры между собой, тогда будут удалятся разные задачи. Например: можно удалить все задачи с конкретным номером телефона, или с деталями.
Если не указан ни один необязательный параметр, вернется ошибка.
В ответ возвращается сообщение об успешной отмене задачи(задач) с ее(их) номером(номерами), либо сообщение об ошибке.
Журнал звонков
URL https://noname.oki-toki.net/api/v1/reports/acd/calls-log
Method: GET
*ключ API создается в настройках Вашего пользователя, как показано в первом пункте документации.
Авторизация по апи токену пользователя. В запросе обязательно должна быть переменная api_token, содержащая токен пользователя.
Без параметров возвращает звонки за последний час.
Параметры:
date_range – период, за который вернуть данные. Значения: last_hour, today, yesterday, this_week, prev_week, this_month, prev_month,
date – дата, за которую вернуть звонки,
anis – номер телефона или ID сессии,
format – формат, в котором вернуть результат. Значения: default, csv, csv_2016. По-умолчанию возвращает в JSON, csv – кодировка CP-1251, csv_2016 – кодировка UTF-8.
А также все остальные поля, используемые в фильтре этого отчёта. Имена переменных и значения можно взять из формы отчёта. Можно так же выполнить отчёт в веб-интерфейсе с нужными параметрами, и скопировать часть url\’а с параметрами из адресной строки, добавив туда api_token.
Примеры
Вместо звёздочек подставьте свой api_token
Звонки за сегодня:
https://noname.oki-toki.net/api/v1/reports/acd/calls-log?date_range=today&api_token=****
Поиск звонка с ID сессии 12345678, совершенный 29.08.2017:
https://noname.oki-toki.net/api/v1/reports/acd/calls-log?date=28.08.2017&anis=12345678&api_token=****
Звонки на/с номера 380501234567, совершенные на прошлой неделе:
https://noname.oki-toki.net/api/v1/reports/acd/calls-log?date_range=prev_week&anis=380501234567&api_token=****
Все звонки за прошлую неделю в CSV (кодировка \”Кириллица Windows-1251\”):
https://noname.oki-toki.net/api/v1/reports/acd/calls-log?date_range=this_week&format=csv&api_token=****
Добавление данных о звонке
URL https://noname.oki-toki.net/api/v1/call/add_data
Method: POST or GET
*ключ API создается в настройках Вашего пользователя, как показано в первом пункте документации.
Передача данных:
Стандартным способом в POST или GET запросе
Нестандартным способом. POST или GET переменная json_request должна содержать в себе json строку с данными.
Авторизация по апи токену пользователя. В запросе обязательно должна быть переменная api_token содержащая токен пользователя.
Обязательные данные:
session_id – уникальный номер звонка в системе Оки-Токи к которому добавляются данные
Примечание.
Если данные добавляются повторно, то они добавляются к уже ранее добавленным.
Если значение какого то параметра будет пустым, то это параметр удалится из набора данных.
В ответ возвращается сообщение об успешном добавлении данных с номером звонка, либо сообщение об ошибке.
Получение данных о звонке
URL https://noname.oki-toki.net/api/v1/call/get_data
Method: POST or GET
*ключ API создается в настройках Вашего пользователя, как показано в первом пункте документации.
Передача данных:
Стандартным способом в POST или GET запросе
Нестандартным способом. POST или GET переменная json_request должна содержать в себе json строку с данными.
Авторизация по апи токену пользователя. В запросе обязательно должна быть переменная api_token содержащая токен пользователя.
Обязательные данные:
session_id – уникальный номер звонка в системе Оки-Токи к которому добавляются данные,
date – дата звонка в формате ДД.ММ.ГГГГ.
В ответ возвращается сообщение с данными о звонке, либо сообщение об ошибке.
Получение записи разговора
URL https://noname.oki-toki.net/api/v1/record/{session_id}
Method: GET
*ключ API создается в настройках Вашего пользователя, как показано в первом пункте документации.
Авторизация по апи токену пользователя. В запросе обязательно должна быть переменная api_token, содержащая токен пользователя.
Параметры:
date – дата звонка. Если не указать, то ищет за последние три месяца
Пример:
https://noname.oki-toki.net/api/v1/record/1234567?date=26.09.2017&api_token=****
Сводный отчёт по звонкам
URL https://noname.oki-toki.net/api/v1/reports/acd/calls-summary
Method: GET
*ключ API создается в настройках Вашего пользователя, как показано в первом пункте документации.
Авторизация по апи токену пользователя. В запросе обязательно должна быть переменная api_token, содержащая токен пользователя.
Без параметров возвращает звонки за последний час.
Параметры:
date_range – период, за который вернуть данные. Значения: last_hour, today, yesterday, this_week, prev_week, this_month, prev_month.
А также все остальные поля, используемые в фильтре этого отчёта. Имена переменных и значения можно взять из формы отчёта. Можно так же выполнить отчёт в веб-интерфейсе с нужными параметрами, и скопировать часть url\’а с параметрами из адресной строки, добавив туда api_token.
Сводные отчеты по очередям и пользователям
URL https://noname.oki-toki.net/api/v1/reports/sec/queue-status-summary (очереди)
и https://noname.oki-toki.net/api/v1/reports/sec/user-status-summary (пользователи)
Method: GET
*ключ API создается в настройках Вашего пользователя, как показано в первом пункте документации.
Авторизация по апи токену пользователя. В запросе обязательно должна быть переменная api_token, содержащая токен пользователя.
Без параметров возвращает статусы за последний час без разбивки.
Параметры:
date_range – период, за который вернуть данные. Значения: last_hour, today, yesterday, this_week, prev_week, this_month, prev_month.
split_by – разбить по очередям или пользователям. Значения: queue, user.
А также все остальные поля, используемые в фильтре этого отчёта. Имена переменных и значения можно взять из формы отчёта. Можно так же выполнить отчёт в веб-интерфейсе с нужными параметрами, и скопировать часть url\’а с параметрами из адресной строки, добавив туда api_token.
Смена статуса оператора
URL https://noname.oki-toki.net/api/v1/user/set_status
Method: POST or GET
*ключ API создается в настройках Вашего пользователя, как показано в первом пункте документации.
Передача переменных:
Стандартным способом в POST или GET запросе
Нестандартным способом. POST или GET переменная json_request должна содержать в себе json строку с данными для изменения статуса
Авторизация по апи токену пользователя. В запросе обязательно должна быть переменная api_token содержащая токен пользователя.
Обязательные данные:
user_id – номер пользователя
status_id – номера статуса (см. тут https://noname.oki-toki.net/company/statuses)
Необязательные данные:
away_status_id – номер дополнительного статуса (см. тут https://noname.oki-toki.net/company/statuses),
status_comment – комментарий к статусу.
В ответ возвращается сообщение об успешном изменении статуса, либо сообщение об ошибке.
Выгрузка контактов из CRM
URL https://noname.oki-toki.net/api/v1/contacts
Method: GET
*ключ API создается в настройках Вашего пользователя, как показано в первом пункте документации.
Передача переменных:
Стандартным способом в GET запросе
Авторизация по апи токену пользователя. В запросе обязательно должна быть переменная api_token содержащая токен пользователя.
Фильтр на выборку контактов:
contact_field1=value1&contact_field2=value2&contact_field3=*value3&
contact_field4=*value4*
contact_field – Имя поля контакта, так как оно отображается в контакте.
=value – точное совпадение с заданным значением,
=*value* – содержит заданное значение
=*value – заданное значение стоит в конце поля,
=value* – заданное значение стоит в начале поля,
value может быть списком в формате списка [1,2,3,4]. Тогда будет найден контакт значение указанного поля которого есть в списке.
В ответ возвращается json массив, содержащий найденные контакты. Количество контактов ограничено 1000 шт.
Проверка существования значения в списке
URL https://noname.oki-toki.net/api/v1/lists/check
Method: GET
*ключ API создается в настройках Вашего пользователя, как показано в первом пункте документации.
Передача переменных:
Стандартным способом в GET запросе
Авторизация по апи токену пользователя. В запросе обязательно должна быть переменная api_token содержащая токен пользователя.
Обязательные данные:
list_id – номер списка в котором делать проверку
Параметры проверки:
value – значение
В ответ возвращается 1 если в списке. 0 – если нет.
Полные данные о заказе (модуль SHOP)
URL https://noname.oki-toki.net/api/v1/shop/order/$id
Method: GET
*ключ API создается в настройках Вашего пользователя, как показано в первом пункте документации.
Передача переменных:
Стандартным способом в GET запросе
Авторизация по апи токену пользователя. В запросе обязательно должна быть переменная api_token содержащая токен пользователя.
Обязательные данные:
$id – номер заказа
В ответ возвращаются полные данные о заказе включая его состав.
API для списка автообзвонов
URL https://noname.oki-toki.net/api/v1/dialers/stat
Method: GET
*ключ API создается в настройках Вашего пользователя, как показано в первом пункте документации.
Передача переменных:
Стандартным способом в GET запросе
Авторизация по апи токену пользователя. В запросе обязательно должна быть переменная api_token содержащая токен пользователя.
Необязательные данные:
$dialer_id – номер автообзвона
В ответ возвращаются данные о всех неархивных автообзвонах, либо если указан $dialer_id – только об одном.[:ua]Потрібні дані та інструкції для інтеграції або вивантаження даних?
Скористайтеся нашими інструкціями.
Отримання ключа API
Додавання завдання (номера) до обдзвону
Видалення завдання (номера) з обдзвону
Журнал дзвінків
Додавання даних про дзвінок
Отримання даних про дзвінок
Отримання запису розмови
Сумарні звіти за чергами та користувачами
Зміна статусу оператора
Вивантаження контактів з CRM
Перевірка існування значення у списку
Повні дані про замовлення (модуль SHOP)
API для списку автообдзвонів
API v.1
h3>Отримання ключа API/h3>
Ключ API створюється в налаштуваннях вашого користувача.
h3>Додавання завдання (номера) до обдзвону/h3>
URL https://home.oki-toki.net/docs/api/#dialers-GETapi-v1-dialers-create_task
Метод: POST або GET
*API ключ створюється в налаштуваннях Вашого користувача, як показано в першому пункті документації
Передача змінних:
Стандартним способом в POST або GET запиті
Нестандартним способом. POST або GET змінна json_request повинна містити в собі json рядок з даними для додавання завдання
Авторизація за допомогою апі токену користувача. У запиті обов\’язково повинна бути змінна api_token, яка містить токен користувача.
Обов\’язкові дані:
dialer_id – номер автодзвінка, в який добавляється завдання
phones – номери телефонів, максимум 5. Через кому, або json підрядком (якщо передається в json_request)
Необов\’язкові дані:
contact_id – номер контакту з CRM Oki-Toki,
bp_id – номер процесу з CRM Oki-Toki,
date – час, на який призначаються дзвінки, у форматі 21.02.2017 12:00:00,
import_id – номер імпорту,
priority приорітет від 0 до 2,
region регіон в форматі часової зони. наприклад Europe/Kiev (якщо регіон буде вказаний, але буде порожнім, то автокорекція поясу (якщо включена) не спрацює, клієнтський графік не спрацює, і дзвінок піде за розкладом роботи автодзвінка),
ttl час життя завдання, в секундах,
user_id номер користувача, на якого помістити завдання,
details – json підрядок з додатковою інформацією, наприклад {\”name\”:\”John\”, \”order\”:\”12\”}
force_create – 1 або 0. Якщо force_create=1, в налаштуваннях автодзвінка включена унікальність та завдання не додається через причину цієї самої унікальності, то при додаванні всі існуючі завдання, які конфліктують з додаванням за унікальним ключем автоматично скасуються,
task_id – номер завдання у автообдзвінку. якщо вказано, то номери телефонів додадуться до завдання з вказаним номером, якщо вона в роботі,
reset_task_id – номер завдання в автодзвінках. Якщо вказано – то система спробує знайти це завдання та встановити його до роботи, замість того щоб створювати нове. Якщо вказані номери телефонів (phones), то система встановить в роботу тільки ті, які вказані. якщо у завдання немає якогось вказаного номера – то він буде до нього доданий. якщо номери не вказані – всі телефони в завданні стануть в чергу.
Відповідно повертається повідомлення про успішне додавання завдання з його номером, або повідомлення про помилку.
h3>Видалення завдання (номера) з автодзвінка/h3>
URL https://noname.oki-toki.net/api/v1/dialers/cancel_task
Метод: POST або GET
*API ключ створюється у налаштуваннях Вашого користувача, як показано в першому пункті документації.
Передача змінних:
Стандартним способом в POST або GET запиті.
Нестандартним способом. POST або GET змінна json_request має містити в собі json рядок з даними для додавання завдання.
Авторизація за api токеном користувача. В запиті обов\’язково має бути змінна api_token, яка містить токен користувача.
Обов\’язкові дані:
dialer_id – номер автодзвінка з якого видаляти завдання (якщо номер = 0, то видаляється з усіх автообдзвонів).
Необов\’язкові дані:
task_id – номер завдання,
phone – номер телефону, який є в завданні,
contact_id – номер контакта з Окі-Токі CRM,
bp_id – номер процесу з Окі-Токі CRM,
details – json підрядок з додатковою інформацією, наприклад {\”name\”:\”John\”, \”order\”:\”12\”}. Скасовуються завдання в яких є задана додаткова інформація,
cancel_phone – 1 (прапор, якщо встановлений, то скасовує тільки вказаний номер телефону),
cancel_reason – причина скасування (може бути наступним з: wrong_number).
Можливо комбінувати необов\’язкові параметри між собою, тоді будуть видалені різні завдання. Наприклад: можна видалити всі завдання з конкретним номером телефону, або з деталями.
Якщо не вказано жоден необов\’язковий параметр, повернеться помилка.
У відповідь повертається повідомлення про успішне скасування завдання(завдань) з її(їх) номером(номерами), або повідомлення про помилку.
h3>Журнал дзвінків/h3>
URL https://noname.oki-toki.net/api/v1/reports/acd/calls-log
Метод: GET
*API ключ створюється в налаштуваннях Вашого користувача, як показано в першому пункті документації.
Авторизація за допомогою API токену користувача. В запиті обов\’язково повинна бути змінна api_token, що містить токен користувача.
Без параметрів повертає дзвінки за останню годину.
Параметри:
date_range – період, за який повернути дані. Значення: last_hour, today, yesterday, this_week, prev_week, this_month, prev_month,
date – дата, за яку повернути дзвінки,
anis – номер телефону або ID сесії,
format – формат, в якому повернути результат. Значення: default, csv, csv_2016. За замовчуванням повертає в JSON, csv – кодування CP-1251, csv_2016 – кодування UTF-8.
Також всі інші поля, що використовуються в фільтрі цього звіту. Імена змінних та значення можна взяти з форми звіту. Також можна виконати звіт в веб-інтерфейсі з потрібними параметрами та скопіювати частину url\’а з параметрами з адресного рядка, додавши туди api_token.
Приклади
Замість зірочок вставте свій api_token
Дзвінки за сьогодні:
https://noname.oki-toki.net/api/v1/reports/acd/calls-log?date_range=today&api_token=****
Пошук дзвінка з ID сесії 12345678, здійснений 29.08.2017:
https://noname.oki-toki.net/api/v1/reports/acd/calls-log?date=28.08.2017&anis=12345678&api_token=****
Дзвінки на/з номера 380501234567, здійснені на минулому тижні:
https://noname.oki-toki.net/api/v1/reports/acd/calls-log?date_range=prev_week&anis=380501234567&api_token=****
Всі дзвінки за минулий тиждень в CSV (кодування \”Кирилиця Windows-1251\”):
https://noname.oki-toki.net/api/v1/reports/acd/calls-log?date_range=this_week&format=csv&api_token=****
h3>Додавання даних про дзвінок/h3>
URL https://noname.oki-toki.net/api/v1/call/add_data
Method: POST or GET
*ключ API створюється у налаштуваннях Вашого користувача, як показано в першому пункті документації.
Передача даних:
Звичайним способом у POST або GET запиті
Незвичайним способом. POST або GET змінна json_request повинна містити в собі json рядок з даними.
Авторизація по api токену користувача. У запиті обов\’язково повинна бути змінна api_token, що містить токен користувача.
Обов\’язкові дані:
session_id – унікальний номер дзвінка в системі Окі-Токі, до якого додаються дані
Примітка.
Якщо дані додаються повторно, то вони додаються до вже раніше доданих.
Якщо значення якогось параметру буде порожнім, то цей параметр видалиться з набору даних.
У відповідь повертається повідомлення про успішне додавання даних з номером дзвінка, або повідомлення про помилку.
h3>Отримання даних про дзвінок/h3>
URL https://noname.oki-toki.net/api/v1/call/get_data
Method: POST or GET
*ключ API створюється в налаштуваннях Вашого користувача, як показано в першому пункті документації.
Передача даних:
Звичайним способом в POST або GET запиті
Незвичайним способом. POST або GET змінна json_request повинна містити в собі json рядок з даними.
Авторизація по api токену користувача. У запиті обов\’язково повинна бути змінна api_token, що містить токен користувача.
Обов\’язкові дані:
session_id – унікальний номер дзвінка в системі Окі-Токі, до якого додаються дані,
date – дата дзвінка у форматі ДД.ММ.РРРР.
У відповідь повертається повідомлення з даними про дзвінок, або повідомлення про помилку.
h3>Отримання запису розмови/h3>
URL https://noname.oki-toki.net/api/v1/record/{session_id}
Метод: GET
*ключ API створюється в налаштуваннях Вашого користувача, як показано в першому пункті документації.
Авторизація за api токеном користувача. В запиті обов\’язково повинна бути змінна api_token, що містить токен користувача.
Параметри:
date – дата дзвінка. Якщо не вказати, то шукає за останні три місяці
Приклад:
https://noname.oki-toki.net/api/v1/record/1234567?date=26.09.2017&api_token=****
h3>Зведений звіт по дзвінках/h3>
URL https://noname.oki-toki.net/api/v1/reports/acd/calls-summary
Метод: GET
*ключ API створюється в налаштуваннях Вашого користувача, як показано в першому пункті документації.
Авторизація за api токеном користувача. В запиті обов\’язково повинна бути змінна api_token, що містить токен користувача.
Без параметрів повертає дзвінки за останню годину.
Параметри:
date_range – період, за який повернути дані. Значення: last_hour, today, yesterday, this_week, prev_week, this_month, prev_month.
А також всі інші поля, що використовуються у фільтрі цього звіту. Імена змінних та значення можна взяти з форми звіту. Ви також можете виконати звіт у веб-інтерфейсі з потрібними параметрами та скопіювати частину url\’а з параметрами з адресного рядка, додавши туди api_token.
h3>Зводні звіти за чергами та користувачами/h3>
URL https://noname.oki-toki.net/api/v1/reports/sec/queue-status-summary (черги)
та https://noname.oki-toki.net/api/v1/reports/sec/user-status-summary (користувачі)
Метод: GET
*API ключ створюється у налаштуваннях Вашого користувача, як показано у першому пункті документації.
Авторизація по апі токену користувача. В запиті обов\’язково повинна бути змінна api_token, що містить токен користувача.
Без параметрів повертає статуси за останню годину без поділу.
Параметри:
date_range – період, за який повернути дані. Значення: last_hour, today, yesterday, this_week, prev_week, this_month, prev_month.
split_by – розподілити за чергами чи користувачами. Значення: queue, user.
А також всі інші поля, що використовуються у фільтрі цього звіту. Імена змінних та значення можна взяти з форми звіту. Можна також виконати звіт у веб-інтерфейсі з потрібними параметрами, і скопіювати частину url\’а з параметрами з адресного рядка, додавши туди api_token.
h3>Зміна статусу оператора/h3>
URL https://noname.oki-toki.net/api/v1/user/set_status
Метод: POST або GET
* API ключ створюється в налаштуваннях Вашого користувача, як показано в першому пункті документації.
Передача змінних:
Стандартним способом в POST або GET запиті
Нестандартним способом. POST або GET змінна json_request має містити в собі json текст з даними для зміни статусу
Авторизація за апи токеном користувача. В запиті обов\’язково має бути змінна api_token, що містить токен користувача.
Обов\’язкові дані:
user_id – номер користувача
status_id – номери статусу (див. тут https://noname.oki-toki.net/company/statuses)
Необов\’язкові дані:
away_status_id – номер додаткового статусу (див. тут https://noname.oki-toki.net/company/statuses),
status_comment – коментар до статусу.
Відповідь повертає повідомлення про успішну зміну статусу, або повідомлення про помилку.
h3>Вивантаження контактів з CRM/h3>
URL https://noname.oki-toki.net/api/v1/contacts
Метод: GET
* API ключ створюється в налаштуваннях Вашого користувача, як показано в першому пункті документації.
Передача змінних:
Стандартним способом в GET запиті
Авторизація за апи токеном користувача. В запиті обов\’язково має бути змінна api_token, що містить токен користувача.
Фільтр на вибірку контактів:
contact_field1=value1&contact_field2=value2&contact_field3=*value3&
contact_field4=*value4*
contact_field – Ім\’я поля контакту, так як воно відображається в контакті.
=value – точне співпадіння з заданим значенням,
=*value* – містить задане значення
=*value – задане значення стоїть в кінці поля,
=value* – задане значення стоїть на початку поля,
value може бути списком у форматі list [1,2,3,4]. В такому випадку буде знайдено контакт, значення вказаного поля якого є у списку.
У відповідь повертається json масив, що містить знайдені контакти. Кількість контактів обмежена 1000 шт.
h3>Перевірка існування значення в списку/h3>
URL https://noname.oki-toki.net/api/v1/lists/check
Method: GET
*API ключ створюється у налаштуваннях Вашого користувача, як показано в першому пункті документації.
Передача змінних:
Стандартним способом в GET запиті
Авторизація за допомогою API токена користувача. У запиті обов\’язково повинна бути змінна api_token, що містить токен користувача.
Обов\’язкові дані:
list_id – номер списку, в якому проводити перевірку
Параметри перевірки:
value – значення
У відповідь повертається 1, якщо в списку. 0 – якщо ні.
h3>Повні дані про замовлення (модуль SHOP)/h3>
URL https://noname.oki-toki.net/api/v1/shop/order/$id
Method: GET
*API ключ створюється у налаштуваннях Вашого користувача, як показано в першому пункті документації.
Передача змінних:
Стандартним способом в GET запиті
Авторизація по API токену користувача. У запиті обов\’язково повинна бути змінна api_token, що містить токен користувача.
Обов\’язкові дані:
$id – номер замовлення
У відповідь повертаються повні дані про замовлення, включаючи його склад.
h3>API для списку автообдзвонів/h3>
URL https://noname.oki-toki.net/api/v1/dialers/stat
Метод: GET
* API-ключ створюється у налаштуваннях вашого користувача, як показано в першому пункті документації.
Передача змінних:
Стандартним способом у GET-запиті
Авторизація за токеном API користувача. У запиті обов\’язково повинна бути змінна api_token, яка містить токен користувача.
Необов\’язкові дані:
$dialer_id – номер авто-опитування
У відповідь повертаються дані про всі активні авто-опитування, або якщо вказано $dialer_id – тільки про одне.[:pl]Czy potrzebujesz danych i instrukcji do integracji lub eksportu danych?
Skorzystaj z naszych instrukcji.
Pobieranie klucza API
Dodawanie zadania (numeru) do autodialera
Usuwanie zadania (numeru) z autodialera
Dziennik połączeń
Dodawanie danych o połączeniu
Pobieranie danych o połączeniu
Pobieranie nagrania rozmowy
Podsumowujące raporty o kolejkach i użytkownikach
Zmiana statusu operatora
Eksportowanie kontaktów z CRM
Sprawdzanie istnienia wartości na liście
Pełne dane o zamówieniu (moduł SHOP)
API dla listy autodialerów
API v.1
h3>Pobieranie klucza API/h3>
Klucz API jest generowany w ustawieniach Twojego użytkownika.
h3>Dodawanie zadania (numeru) do autodialera/h3>
URL https://home.oki-toki.net/docs/api/#dialers-GETapi-v1-dialers-create_task
Metoda: POST lub GET
*Klucz API jest tworzony w ustawieniach Twojego użytkownika, jak pokazano w pierwszym punkcie dokumentacji
Przekazywanie zmiennych:
Standardowy sposób w zapytaniu POST lub GET
Niestandardowy sposób. Zmienna POST lub GET json_request musi zawierać w sobie ciąg json z danymi do dodania zadania.
Autoryzacja przez token API użytkownika. W zapytaniu musi być obowiązkowo zmienna api_token zawierająca token użytkownika.
Wymagane dane:
dialer_id – numer autodialera do którego dodawane jest zadanie
telefony – numery telefonów, maksymalnie 5. Oddzielone przecinkami lub ciągiem json (jeśli przekazywane są w json_request)
Dane niewymagane:
contact_id – numer kontaktu z CRM Oki-Toki,
bp_id – numer procesu z CRM Oki-Toki,
data – czas na który zarezerwowane są rozmowy, w formacie 21.02.2017 12:00:00,
import_id – numer importu,
priorytet priorytetu od 0 do 2,
region region w formacie strefy czasowej, np. Europe/Kiev (jeżeli region będzie wskazany, ale będzie pusty, to autokorekta strefy (jeżeli jest włączona) nie zadziała, harmonogram klienta nie zadziała, a rozmowa zostanie przeprowadzona zgodnie z harmonogramem pracy autodialera),
ttl czas życia zadania, w sekundach,
user_id numer użytkownika do którego przypisane jest zadanie,
szczegóły – ciąg json z dodatkowymi informacjami, na przykład {\”name\”:\”John\”, \”order\”:\”12\”}
wymuszanie tworzenia – 1 lub 0. Jeśli force_create=1, w ustawieniach autodialera jest włączona unikalność i zadanie nie jest dodawane z powodu tej unikalności, to podczas dodawania wszystkie istniejące zadania konfliktujące z dodawanym przez unikalny klucz
Automatycznie zostaną anulowane, task_id – numer zadania w autodialerze. Jeśli jest podany, numery telefonów zostają dodane do zadania o podanym numerze, jeśli jest w trakcie przetwarzania,
reset_task_id – numer zadania w autodialerze. Jeżeli podano – system spróbuje znaleźć to zadanie i umieścić je w pracy, zamiast tworzyć nowe. Jeżeli podane są numery telefonów (telefony), system włączy do pracy tylko te, które są podane. jeżeli zadanie nie ma żadnego podanego numeru – zostanie do niego dodane. jeśli numery nie są podane – wszystkie telefony w zadaniu zostaną umieszczone w kolejce[:es]¿Necesitan datos e instrucciones para integración o exportación de datos?
Utilice nuestras instrucciones.
Obtención de la clave API
Añadir tarea (número) para llamadas automáticas
Eliminar tarea (número) de llamadas automáticas
Registro de llamadas
Agregar datos sobre la llamada
Obtener datos de la llamada
Obtener grabación de la conversación
Reportes consolidados por colas y usuarios
Cambiar el estado del Agente
Exportar contactos del CRM
Verificar la existencia de un valor en la lista
Datos completos del pedido (módulo SHOP)
API para la lista de llamadas automáticas
API v.1
Obtención de la clave API
La clave API se crea en la configuración de su usuario.
Añadir tarea (número) para llamadas automáticas
URL https://home.oki-toki.net/docs/api/#dialers-GETapi-v1-dialers-create_task
Método: POST o GET
*La clave API se crea en la configuración de su usuario, como se muestra en el primer punto de la documentación
Transferencia de variables:
De forma estándar en una solicitud POST o GET
De forma no estándar. La variable POST o GET json_request debe contener una cadena json con los datos para añadir la tarea
Autorización por token de API del usuario. La solicitud debe contener obligatoriamente la variable api_token que contenga el token del usuario.
Datos obligatorios:
dialer_id – número de llamada automática al que se añade la tarea
phones – números de teléfono, máximo 5. Separados por comas o como subcadena json (si se pasa en json_request)
Datos opcionales:
contact_id – número de contacto de CRM Oki-Toki,
bp_id – número de proceso del CRM Oki-Toki,
date – tiempo para el que se programan las llamadas, en el formato 21.02.2017 12:00:00,
import_id – número de importación,
priority – prioridad de 0 a 2,
region – región en formato de zona horaria, por ejemplo, Europe/Kiev (si se especifica la región, pero está vacía, entonces la autodelimitación de zona (si está habilitada) no funcionará, el horario del cliente no funcionará y la llamada se realizará según el horario de funcionamiento de llamada automática),
ttl – tiempo de vida de la tarea, en segundos,
user_id – número de usuario al que asignar la tarea,
details – subcadena json con información adicional, por ejemplo {\”name\”:\”John\”, \”order\”:\”12\”}
force_create – 1 o 0. Si force_create=1, se habilita la unicidad en la configuración de llamadas automáticas y la tarea no se añade debido a esta unicidad, entonces al añadir todas las tareas existentes que entren en conflicto con la que se añade por la clave única se cancelarán automáticamente,
task_id – número de tarea en llamada automática. Si se especifica, los números de teléfono se añadirán a la tarea con el número especificado, si está en progreso,
reset_task_id – número de tarea en llamada automática. Si se especifica, el sistema intentará encontrar esta tarea y ponerla en marcha, en lugar de crear una nueva. Si se especifican los números de teléfono (phones), el sistema solo pondrá en marcha los que se han especificado. Si la tarea no tiene alguno de los números especificados, se le añadirá. Si no se especifican los números, todos los teléfonos en la tarea se pondrán en cola.
En respuesta se devuelve un mensaje sobre el éxito del añadido de la tarea con su número o un mensaje de error.
Eliminar tarea (número) de llamadas automáticas
URL https://noname.oki-toki.net/api/v1/dialers/cancel_task
Método: POST o GET
*La clave API se crea en la configuración de su usuario, como se muestra en el primer punto de la documentación.
Transferencia de variables:
De forma estándar en una solicitud POST o GET.
De forma no estándar. La variable POST o GET json_request debe contener una cadena json con los datos para añadir la tarea.
Autorización por token de API del usuario. La solicitud debe contener obligatoriamente la variable api_token que contenga el token del usuario.
Datos obligatorios:
dialer_id – número de llamada automática del que eliminar la tarea (si el número = 0, entonces se eliminan de todas las llamadas automáticas).
Datos opcionales:
task_id – número de tarea,
phone – número de teléfono que está en la tarea,
contact_id – número de contacto de CRM Oki-Toki,
bp_id – número de proceso de CRM Oki-Toki,
details – subcadena json con información adicional, por ejemplo {\”name\”:\”John\”, \”order\”:\”12\”}. Se cancelan las tareas que contengan la información adicional especificada,
cancel_phone – 1 (bandera, si se establece, solo se cancela el número de teléfono especificado),
cancel_reason – motivo de cancelación (puede ser uno de los siguientes: wrong_number).
Se pueden combinar parámetros opcionales entre ellos, entonces se eliminarán diferentes tareas. Por ejemplo: se pueden eliminar todas las tareas con un número de teléfono específico o con detalles.
Si no se especifica ningún parámetro opcional, se devuelve un error.
En respuesta se devuelve un mensaje sobre la cancelación exitosa de la tarea (tareas) con su número (números) o un mensaje de error.
Registro de llamadas
URL https://noname.oki-toki.net/api/v1/reports/acd/calls-log
Método: GET
*La clave API se crea en la configuración de su usuario, como se muestra en el primer punto de la documentación.
Autorización por token de API del usuario. La solicitud debe contener obligatoriamente la variable api_token, que contenga el token del usuario.
Sin parámetros devuelve llamadas del última hora.
Parámetros:
date_range – el periodo para el que devolver los datos. Valores: last_hour, today, yesterday, this_week, prev_week, this_month, prev_month,
date – fecha para la cual devolver llamadas,
anis – número de teléfono o ID de sesión,
format – formato en el que devolver el resultado. Valores: default, csv, csv_2016. Por defecto devuelve en JSON, csv – codificación CP-1251, csv_2016 – codificación UTF-8.
Así como todos los demás campos utilizados en el filtro de este informe. Los nombres de las variables y los valores se pueden tomar del formulario del informe. También se puede realizar el informe en la interfaz web con los parámetros deseados, y copiar parte del URL con los parámetros de la barra de direcciones, agregando allí api_token.
Ejemplos
En lugar de los asteriscos introduzca su api_token
Llamadas de hoy:
https://noname.oki-toki.net/api/v1/reports/acd/calls-log?date_range=today&api_token=****
Buscar una llamada con ID de sesión 12345678, realizada el 29.08.2017:
https://noname.oki-toki.net/api/v1/reports/acd/calls-log?date=28.08.2017&anis=12345678&api_token=****
Llamadas de/para el número 380501234567, realizadas la semana pasada:
https://noname.oki-toki.net/api/v1/reports/acd/calls-log?date_range=prev_week&anis=380501234567&api_token=****
Todas las llamadas de la semana pasada en CSV (codificación \”Cirílico Windows-1251\”):
https://noname.oki-toki.net/api/v1/reports/acd/calls-log?date_range=this_week&format=csv&api_token=****
Agregar datos sobre la llamada
URL https://noname.oki-toki.net/api/v1/call/add_data
Método: POST o GET
*La clave API se crea en la configuración de su usuario, como se muestra en el primer punto de la documentación.
Transferencia de datos:
De forma estándar en una solicitud POST o GET
Autorización por token de API del usuario. La solicitud debe contener obligatoriamente la variable api_token, que contenga el token del usuario.
Datos obligatorios:
session_id – número único de la llamada en el sistema Oki-Toki al que se añaden datos
Nota.
Si los datos se añaden de nuevo, entonces se añaden a los ya añadidos previamente.
Si el valor de algún parámetro está vacío, ese parámetro se eliminará del conjunto de datos.
En respuesta se devuelve un mensaje sobre el éxito del añadido de datos con el número de llamada, o un mensaje de error.
Obtener datos de la llamada
URL https://noname.oki-toki.net/api/v1/call/get_data
Método: POST o GET
*La clave API se crea en la configuración de su usuario, como se muestra en el primer punto de la documentación.
Transferencia de datos:
De forma estándar en una solicitud POST o GET
Autorización por token de API del usuario. La solicitud debe contener obligatoriamente la variable api_token, que contenga el token del usuario.
Datos obligatorios:
session_id – número único de la llamada en el sistema Oki-Toki al que se añaden datos,
date – fecha de la llamada en el formato DD.MM.AAAA.
En respuesta se devuelve un mensaje con los datos de la llamada o un mensaje de error.
Obtener grabación de la conversación
URL https://noname.oki-toki.net/api/v1/record/{session_id}
Método: GET
*La clave API se crea en la configuración de su usuario, como se muestra en el primer punto de la documentación.
Autorización por token de API del usuario. La solicitud debe contener obligatoriamente la variable api_token, que contenga el token del usuario.
Parámetros:
date – fecha de la llamada. Si no se indica, busca en los últimos tres meses
Ejemplo:
https://noname.oki-toki.net/api/v1/record/1234567?date=26.09.2017&api_token=****
Reporte consolidado por llamadas
URL https://noname.oki-toki.net/api/v1/reports/acd/calls-summary
Método: GET
*La clave API se crea en la configuración de su usuario, como se muestra en el primer punto de la documentación.
Autorización por token de API del usuario. La solicitud debe contener obligatoriamente la variable api_token, que contenga el token del usuario.
Sin parámetros devuelve llamadas del última hora.
Parámetros:
date_range – el periodo para el que devolver los datos. Valores: last_hour, today, yesterday, this_week, prev_week, this_month, prev_month.
Así como todos los demás campos utilizados en el filtro de este informe. Los nombres de las variables y los valores se pueden tomar del formulario del informe. También se puede realizar el informe en la interfaz web con los parámetros deseados, y copiar parte del URL con los parámetros de la barra de direcciones, agregando allí api_token.
Reportes consolidados por colas y usuarios
URL https://noname.oki-toki.net/api/v1/reports/sec/queue-status-summary (colas)
y https://noname.oki-toki.net/api/v1/reports/sec/user-status-summary (usuarios)
Método: GET
*La clave API se crea en la configuración de su usuario, como se muestra en el primer punto de la documentación.
Autorización por token de API del usuario. La solicitud debe contener obligatoriamente la variable api_token, que contenga el token del usuario.
Sin parámetros devuelve los estados de la última hora sin desglose.
Parámetros:
date_range – el periodo para el que devolver los datos. Valores: last_hour, today, yesterday, this_week, prev_week, this_month, prev_month.
split_by – dividir por colas o usuarios. Valores: queue, user.
Así como todos los demás campos utilizados en el filtro de este informe. Los nombres de las variables y los valores se pueden tomar del formulario del informe. También se puede realizar el informe en la interfaz web con los parámetros deseados, y copiar parte del URL con los parámetros de la barra de direcciones, agregando allí api_token.
Cambiar el estado del Agente
URL https://noname.oki-toki.net/api/v1/user/set_status
Método: POST o GET
*La clave API se crea en la configuración de su usuario, como se muestra en el primer punto de la documentación.
Transferencia de variables:
De forma estándar en una solicitud POST o GET
De forma no estándar. La variable POST o GET json_request debe contener una cadena json con los datos para cambiar el estado
Autorización por token de API del usuario. La solicitud debe contener obligatoriamente la variable api_token, que contenga el token del usuario.
Datos obligatorios:
user_id – número de usuario
status_id – número de estado (ver aquí https://noname.oki-toki.net/company/statuses)
Datos opcionales:
away_status_id – número de estado adicional (ver aquí https://noname.oki-toki.net/company/statuses),
status_comment – comentario al estado.
En respuesta se devuelve un mensaje sobre el cambio de estado exitoso o un mensaje de error.
Exportar contactos del CRM
URL https://noname.oki-toki.net/api/v1/contacts
Método: GET
*La clave API se crea en la configuración de su usuario, como se muestra en el primer punto de la documentación.
Transferencia de variables:
De forma estándar en una solicitud GET
Autorización por token de API del usuario. La solicitud debe contener obligatoriamente la variable api_token, que contenga el token del usuario.
Filtro para la selección de contactos:
contact_field1=value1&contact_field2=value2&contact_field3=*value3&contact_field4=*value4*
contact_field – Nombre del campo de contacto, tal como se muestra en el contacto.
=value – coincidencia exacta con el valor especificado,
=*value* – contiene el valor especificado,
=value* – el valor especificado está al principio del campo,
=*value – el valor especificado está al final del campo,
value puede ser una lista en el formato [1,2,3,4]. Entonces se encontrarán contactos cuyos valores de campo especificados estén en la lista.
En respuesta se devuelve una matriz json que contiene los contactos encontrados. La cantidad de contactos está limitada a 1000 unidades.
Verificar la existencia de un valor en la lista
URL https://noname.oki-toki.net/api/v1/lists/check
Método: GET
*La clave API se crea en la configuración de su usuario, como se muestra en el primer punto de la documentación.
Transferencia de variables:
De forma estándar en una solicitud GET
Autorización por token de API del usuario. La solicitud debe contener obligatoriamente la variable api_token, que contenga el token del usuario.
Datos obligatorios:
list_id – número de la lista en la que se realizará la verificación
Parámetros de verificación:
value – el valor
En respuesta se devuelve 1 si el valor está en la lista. 0 si no está.
Datos completos del pedido (módulo SHOP)
URL https://noname.oki-toki.net/api/v1/shop/order/$id
Método: GET
*La clave API se crea en la configuración de su usuario, como se muestra en el primer punto de la documentación.
Transferencia de variables:
De forma estándar en una solicitud GET
Autorización por token de API del usuario. La solicitud debe contener obligatoriamente la variable api_token, que contenga el token del usuario.
Datos obligatorios:
$id – número de pedido
En respuesta se devuelven datos completos del pedido, incluidos los detalles del mismo.
API para la lista de llamadas automáticas
URL https://noname.oki-toki.net/api/v1/dialers/stat
Método: GET
*La clave API se crea en la configuración de su usuario, como se muestra en el primer punto de la documentación.
Transferencia de variables:
De forma estándar en una solicitud GET
Autorización por token de API del usuario. La solicitud debe contener obligatoriamente la variable api_token, que contenga el token del usuario.
Datos opcionales:
$dialer_id – número de llamada automática
En respuesta se devuelven datos sobre todas las llamadas automáticas no archivadas, o si se ha especificado $dialer_id, solo sobre una.[:tr]Veri ve entegrasyon talimatlarına mı ihtiyacınız var?
Talimatlarımızı kullanın.
API anahtarı alımı
Aramaya görev (numara) ekleme
Aramadan görev (numara) silme
Arama kaydı
Arama verileri ekleme
Arama verilerini alma
Konuşma kaydı alma
Kuyruklar ve kullanıcılar için özet raporlar
Ajantın durumunu değiştirme
CRM\’den iletişim bilgileri çıkarma
Listede bir değerin varlığını kontrol etme
Sipariş detayları hakkında tam bilgi (SHOP modülü)
Otomatik arama listesi için API
API v.1
API anahtarı alımı
API anahtarı kullanıcı ayarlarınız içinde oluşturulur.
Aramaya görev (numara) eklemek
URL https://home.oki-toki.net/docs/api/#dialers-GETapi-v1-dialers-create_task
Method: POST veya GET
*API anahtarı kullanıcınızın ayarları içinde oluşturulur, bu, belgenin ilk adımında gösterildiği gibidir.
Değişkenlerin verilmesi:
Standart yöntemle POST veya GET talebinde
Standart olmayan yöntem. POST veya GET json_request değişkeni görevi eklemek için veriler içeren json dizgisini içermelidir
Kullanıcının api token\’ı ile yetkilendirme. Talepte kullanıcı token\’ı içeren api_token değişkeni mutlaka bulunmalıdır.
Zorunlu veriler:
dialer_id – eklemek için görevin numarası olan otomatik aramada
phones – telefon numaraları, maksimum 5. Virgülle ya da json alt dizgisi ile (eğer json_request içinde veriliyorsa)
İsteğe bağlı veriler:
contact_id – Oki-Toki CRM\’den iletişim numarası,
bp_id – Oki-Toki CRM\’den işlem numarası,
date – aramaların atandığı zaman, 21.02.2017 12:00:00 formatında,
import_id – ithalat numarası,
priority öncelik 0 ile 2 arasında,
region saat dilimi formatında bölge. örneğin Europe/Kiev (eğer bölge belirtilirse ama boş olursa, saat dilimi otokoreksiyonu(aktifse) çalışmaz, müşteri takvimi çalışmaz ve arama otomatik arama çalışma programına göre yapılır),
ttl görevin yaşam süresi, saniye cinsinden,
user_id görevin atanacağı kullanıcının numarası,
details – ek bilgi içeren json alt dizgisi, örneğin {\”name\”:\”John\”, \”order\”:\”12\”}
force_create – 1 veya 0. Eğer force_create=1, otomatik aramada ayarlarda benzersizlik aktifse ve görev benzersizlik sebebiyle eklenmiyorsa, ekleme sırasında var olan tüm çakışan görevler otomatik olarak iptal edilecek,
task_id – otomatik aramadaki görev numarası. eğer belirtilmişse telefon numaraları belirtilen numaraya eklenir, eğer çalışmada ise,
reset_task_id – otomatik aramadaki görev numarası. eğer belirtilmişse – sistem bu görevi bulmaya ve yeni bir şey yaratmak yerine onu çalışmaya koymaya çalışacak. Eğer telefon numaraları (phones) belirtilmişse, sistem sadece belirtilenleri çalışmaya koyacak. eğer görevde belirtilen herhangi bir numara yoksa – o, göreve eklenecek. eğer numaralar belirtilmemişse – görevdeki tüm telefonlar sıraya girecek.
Cevap, görevin başarıyla eklendiği ile ilgili mesaj ile dönecek, numarası ile birlikte, ya da hata mesajı ile.
Aramadan görev (numara) silme
URL https://noname.oki-toki.net/api/v1/dialers/cancel_task
Method: POST veya GET
*Kullanıcınızın ayarları içinde API anahtarı oluşturulur, bu belgenin ilk adımında gösterildiği gibidir.
Değişkenlerin verilmesi:
Standart yöntemle POST veya GET talebinde.
Standart olmayan yöntem. POST veya GET json_request değişkeni görevi eklemek için veriler içeren json dizgisini içermelidir.
Kullanıcının api token\’ı ile yetkilendirme. Talepte kullanıcı token\’ı içeren api_token değişkeni mutlaka bulunmalıdır.
Zorunlu veriler:
dialer_id – görevin silineceği otomatik aramadan numara (eğer numara = 0 ise, tüm otomatik aramalardan silinir).
İsteğe bağlı veriler:
task_id – görev numarası,
phone – görevde olan telefon numarası,
contact_id – Oki-Toki CRM\’den iletişim numarası,
bp_id – Oki-Toki CRM\’den işlem numarası,
details – ek bilgi içeren json alt dizgisi, örneğin {\”name\”:\”John\”, \”order\”:\”12\”}. Belirtilen ek bilgiye sahip görevler iptal edilir,
cancel_phone – 1 (bayrak, eğer ayarlanmışsa, sadece belirtilen telefon numarasını iptal eder),
cancel_reason – iptal sebebi (şu sebeplerden biri olabilir: wrong_number).
İsteğe bağlı parametreler birbiriyle kombin edilebilir, bu durumda farklı görevler silinir. Örneğin: belirli bir telefon numarasıyla tüm görevleri silmek veya detayları ile mümkün.
Herhangi bir isteğe bağlı parametre belirtilmemişse, hata döner.
Cevap başarıyla iptal edilen görev(ler) ile ilgili mesaj ile dönecek, onun(ların) numarası(numaraları) ile birlikte, ya da hata mesajı ile.
Arama kaydı
URL https://noname.oki-toki.net/api/v1/reports/acd/calls-log
Method: GET
*Kullanıcınızın ayarları içinde API anahtarı olu…[:]